home *** CD-ROM | disk | FTP | other *** search
/ Atari Mega Archive 2 / Atari Mega Archive CD - Volume 2.iso / minix / up1510b.tgz / up1510b / man / READ_ME < prev   
Text File  |  1990-07-19  |  4KB  |  139 lines
  1. This directory contains the man files.  Man1 is "official" in the sense that 
  2. it is not expected to undergo many changes, other than bug fixes.  
  3. Man2 wass put together in an hour.  Someday a proper POSIX version of man2,
  4. as well as man3 (library), man4 (device drivers), man5 (file formats),
  5. and man6 (other) may appear.  Given the nature of MINIX systems and users,
  6. the distinction between part 1 (serious commands), part 6 (games), and
  7. part 8 (superuser commands) is very subtle.  I'll put all commands in Part 1.
  8.  
  9. If there are any volunteers who want to write the descriptions for the POSIX 
  10. and ANSI functions, please let me know.  In any event, it is absolutely
  11. illegal to copy text from 4.3 BSD manuals, System V manuals, ANSI standards,
  12. IEEE standards, or any other copyrighted work.  You have to write your own.
  13.  
  14. People writing man entries are requested to keep them short enough to fit on
  15. one screen (24 lines), where possible.  The original file should be in troff
  16. form, with the manX entries being the nroff output.
  17. I may include the man pages in the book again (see pages 384-409 in the book).
  18. To do this, I need input setup for typesetting.
  19. Below is a sample original entry.  All my man1 entries are in this form.
  20. P-H would not approve of my distributing the true input :-(  
  21. Please don't ask.  
  22.  
  23. Note that I use \(en for the short dash.  
  24. True troff connoisseurs are concerned about the difference between:
  25.      -      \(en      \(em      \(mi      _      and      \(ru
  26. I have gotten artwork from P-H where they used - when I wanted \(en and
  27. I rejected the whole lot at no mean expense.
  28.  
  29.  
  30. .CD "backup \(en backup files"
  31. .SX "backup \fR[\fB\(endmnvz\fR]"
  32. .FL "\(end" "At top level, only directories are backed up"
  33. .FL "\(enj" "Do not copy junk: *.o, *.Z, *.bak, a.out core, etc"
  34. .FL "\(enm" "If device full, prompt for new diskette"
  35. .FL "\(enn" "Do not backup top-level directories"
  36. .FL "\(ens" "Do not copy *.s files"
  37. .FL "\(env" "Verbose; list files being backed up"
  38. .FL "\(enz" "Compress the files on the backup medium"
  39. .EX "backup -mz . /f0" "Backup current directory compressed"
  40. .EX "backup /bin /usr/bin" "Backup bin from RAM disk to hard disk"
  41. .PP
  42. \fIBackup\fR (recursively) backs up the contents of a given directory and its
  43. subdirectories to another part of the file system.
  44. It is two typical uses.
  45. First, some portion of the file system can be backed up onto 1 or more
  46. diskettes.
  47. When a diskette fills up, the user is prompted for a new one.
  48. The backups are in the form of mountable file systems.
  49. Second, a directory on RAM disk can be backed up onto hard disk.
  50. If the target directory is empty, the entire source directory is copied
  51. there, optionally compressed to save space.
  52. If the target directory is an old backup, only those files changed since
  53. the backup was made are copied.
  54. \fIBackup\fR uses times for this purpose, like \fImake\fR.
  55.  
  56.  
  57. For part 2 (will be the ca. 80 POSIX calls) and part 3 (other lib routines,
  58. hopefully most ANSI compatible), follow this example:
  59.  
  60. .NA "fseek \(en seek on a file"
  61. .SX "fseek(FILE *stream, long int offset, int whence)"
  62. .DE
  63. \fIFseek\fR sets the file position for \fIstream\fR.
  64. The \fIoffset\fR parameter tells where to put it depending on \fIwhence\fR.
  65. \fIWhence\fR can take on one of three values: SEEK_SET (set the file position
  66. to \fIoffset\fR), SEEK_CUR (\fIoffset\fR is relative to the current position),
  67. or SEEK_END (\fIoffset\fR is relative to the end of the file).
  68. .DI
  69. On error, -1 is returned ...
  70. .SA
  71. lseek(2), fopen(3)
  72. .BU
  73. No known bugs
  74.  
  75.  
  76. The macros are as follows:
  77.  
  78. .de CD
  79. .if t .ta 0.9i 1.15i 2.75i
  80. .if n .ta 11m 13m 40m
  81. .nr x 0 0
  82. .nr y 0 0
  83. .nr z 0 0
  84. .if n #\\$1
  85. .if n .br
  86. \\fBCommand:\&    \\$1\\fR
  87. .br
  88. ..
  89. .de SX
  90. .if \\nx<=0 \\fBSyntax:\&    \\$1
  91. .if \\nx>0 \&    \\fB\\$1
  92. .nr x 1 1
  93. .br
  94. ..
  95. .de FL
  96. .if \\ny<=0 \\fBFlags:\&    \\fB\\$1    \\fR\\$2
  97. .if \\ny>0 \&     \\fB\\$1    \\fR\\$2
  98. .nr y 1 1
  99. .br
  100. ..
  101. .de EX
  102. .br
  103. .nf
  104. .if \\nz<=0 \\fB\&Examples:    \\fR\\$1    \\fR# \\$2
  105. .if \\nz>0 \&    \\fR\\$1    \\fR# \\$2
  106. .nr z 1 1
  107. .br
  108. ..
  109. .de EY
  110. .br
  111. .nf
  112. .if \\nz<=0 \\fB\&Example:    \\fR\\$1    \\fR# \\$2
  113. .if \\nz>0 \&    \\fR\\$1    \\fR# \\$2
  114. .nr z 1 1
  115. .br
  116. ..
  117. .de NA
  118. .if \\fBName:\&    \\$1
  119. .br
  120. ..
  121. .de DE
  122. \\fBDescription:\\fR
  123. .PP
  124. ..
  125. .de DI
  126. Diagnostics:
  127. .PP
  128. ..
  129. .de SA
  130. \\fBSee Also:\\fR
  131. .PP
  132. ..
  133. .de BU
  134. \\fBBugs:\\fR
  135. ..
  136. .de IN
  137. \\fBInclude files:\\fR
  138. ..
  139.